Pular para o conteúdo principal

13.1 Listar Signatários de Aceite Digital

Request

Request
query DigitalAcceptanceSignatories {
digitalAcceptanceSignatories(
where: {
document: {
id: { eq: 1 }
}
}
) {
pageInfo {
hasNextPage
hasPreviousPage
}
items {
id
refId
fullName
email
cpf
type
phone
accessLink
status
acceptedAt
rejectedAt
rejectionReason
ipAddress
userAgent
geoLocation
documentHashAtAcceptance
notes
inviteSentAt
attemptCount
emailSendStatus
emailSendError
creationDate
active
document {
id
title
status
company {
id
name
}
}
}
totalCount
}
}

Params

ParâmetroTipoDescrição
skipIntNúmero de registros a pular
takeIntQuantidade de registros
whereDigitalAcceptanceSignatoryFilterInputFiltros de busca
order[DigitalAcceptanceSignatorySortInput!]Ordenação dos resultados

Filtros Disponíveis

Objeto DigitalAcceptanceSignatoryFilterInput

CampoTipoDescrição
and[DigitalAcceptanceSignatoryFilterInput!]Operador lógico AND
or[DigitalAcceptanceSignatoryFilterInput!]Operador lógico OR
idIntOperationFilterInputFiltro por ID
refIdUuidOperationFilterInputFiltro por RefID
fullNameStringOperationFilterInputFiltro por nome completo
emailStringOperationFilterInputFiltro por email
cpfStringOperationFilterInputFiltro por CPF
typeSignatoryTypeOperationFilterInputFiltro por tipo de signatário
phoneStringOperationFilterInputFiltro por telefone
statusAcceptanceStatusOperationFilterInputFiltro por status do aceite
acceptedAtDateTimeOperationFilterInputFiltro por data de aceite
rejectedAtDateTimeOperationFilterInputFiltro por data de rejeição
rejectionReasonStringOperationFilterInputFiltro por motivo de rejeição
inviteSentAtDateTimeOperationFilterInputFiltro por data de envio
attemptCountIntOperationFilterInputFiltro por tentativas de aceite
emailSendStatusEmailSendStatusOperationFilterInputFiltro por status de envio email
documentDigitalAcceptanceDocumentFilterInputFiltro por documento
creationDateDateTimeOperationFilterInputFiltro por data de criação
activeBooleanOperationFilterInputFiltro por status ativo

Enum SignatoryType

ValorDescrição
CONTRACTORContratante
CONTRACTEDContratado
WITNESSTestemunha

Enum AcceptanceStatus

ValorDescrição
PENDINGPendente
ACCEPTEDAceito
REJECTEDRejeitado
EXPIREDExpirado

Enum EmailSendStatus

ValorDescrição
UNDEFINEDIndefinido
NOT_SENTNão enviado
SENTEnviado

Ordenação

Objeto DigitalAcceptanceSignatorySortInput

CampoTipoDescrição
idSortEnumTypeOrdenar pela ID interna
fullNameSortEnumTypeOrdenar por nome completo
emailSortEnumTypeOrdenar por e-mail
cpfSortEnumTypeOrdenar por CPF
typeSortEnumTypeOrdenar por tipo
statusSortEnumTypeOrdenar por status do documento
acceptedAtSortEnumTypeOrdenar por data de aceite
rejectedAtSortEnumTypeOrdenar por data de rejeição
inviteSentAtSortEnumTypeOrdenar por data de envio do convite
attemptCountSortEnumTypeOrdenar por número de tentativas
emailSendStatusSortEnumTypeOrdenar por status de envio de e-mail
creationDateSortEnumTypeOrdenar por data de criação do registro

Response

CampoTipoDescrição
pageInfoCollectionSegmentInfo!Informações de paginação
items[DigitalAcceptanceSignatory!]!Lista de signatários retornados na página atual
totalCountInt!Total de registros disponíveis

Objeto CollectionSegmentInfo

Contém metadados sobre a paginação da coleção.

CampoTipoDescrição
hasNextPageBoolean!Indica se há uma próxima página de resultados
hasPreviousPageBoolean!Indica se há uma página anterior de resultados

Objeto DigitalAcceptanceSignatory

Detalhes completos de um signatário de um documento de aceite digital.

CampoTipoDescrição
idInt!ID interno do signatário
refIdUUID!ID de referência (externo)
fullNameString!Nome completo do signatário
emailString!E-mail do signatário
cpfString!CPF do signatário
typeSignatoryType!Tipo de signatário (ex: Aluno, Responsável)
phoneStringTelefone do signatário
accessLinkString!Link único de acesso para o aceite
statusAcceptanceStatus!Status atual do aceite (ex: Pendente, Aceito, Rejeitado)
acceptedAtDateTimeData e hora do aceite
rejectedAtDateTimeData e hora da rejeição
rejectionReasonStringMotivo da rejeição (se aplicável)
ipAddressStringIP utilizado no aceite/rejeição
userAgentStringUser-Agent (browser) utilizado no aceite/rejeição
geoLocationStringLocalização geográfica registrada
documentHashAtAcceptanceStringHash do documento no momento do aceite para verificação
notesStringObservações
inviteSentAtDateTimeData de envio do convite
attemptCountInt!Número de tentativas de aceite
emailSendStatusEmailSendStatus!Status do último envio de e-mail
emailSendErrorStringMensagem de erro do envio de e-mail (se houver)
creationDateDateTime!Data de criação do registro
activeBoolean!Status ativo
documentDigitalAcceptanceDocumentDocumento de aceite digital relacionado
accessLinkUrlString!URL completa do link de acesso

Objeto DigitalAcceptanceDocument

Detalhes do documento de aceite digital ao qual o signatário está vinculado.

CampoTipoDescrição
idInt!ID interno do documento
refIdUUID!ID de referência (externo)
titleString!Título do documento
statusDigitalAcceptanceStatus!Status geral do documento (ex: Completo, Aberto)
companyCompanyEmpresa relacionada ao documento

Objeto Company

Informações básicas da empresa.

CampoTipoDescrição
idInt!ID da empresa
nameString!Nome da empresa